<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.7.0" />

	<title>Interface Swift_KeyCache | nort</title>

	<script type="text/javascript" src="resources/combined.js?1481722677"></script>
	<script type="text/javascript" src="elementlist.js?1094816827"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?1567499433" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-App.html">App<span></span></a>
						<ul>
				<li><a href="package-App.Saas.html">Saas</a>
						</li>
				<li><a href="package-App.saas.html">saas</a>
						</li>
				<li><a href="package-App.SaaS.html">SaaS<span></span></a>
						<ul>
				<li><a href="package-App.saas.Logic.html">Logic</a>
						</li>
				<li><a href="package-App.SaaS.SaaS.html">SaaS</a>
						</li>
				<li><a href="package-App.Saas.Tables.html">Tables</a>
						</li>
				<li><a href="package-App.Saas.Vo.html">Vo</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-aqua.html">aqua<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-aqua.tools.Monitor.html">Monitor</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-flashservices.html">flashservices<span></span></a>
						<ul>
				<li><a href="package-flashservices.adapters.html">adapters</a>
						</li>
				<li><a href="package-flashservices.debug.html">debug</a>
						</li>
				<li><a href="package-flashservices.exception.html">exception</a>
						</li>
				<li><a href="package-flashservices.filters.html">filters</a>
						</li>
				<li><a href="package-flashservices.io.html">io</a>
						</li>
				<li><a href="package-flashservices.sql.html">sql</a>
						</li>
				<li><a href="package-flashservices.util.html">util</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.html">Mekayotl<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.core.html">core</a>
						</li>
				<li><a href="package-Mekayotl.database.html">database<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.database.dal.html">dal</a>
						</li>
				<li><a href="package-Mekayotl.database.mysql.html">mysql</a>
						</li>
				<li><a href="package-Mekayotl.database.sqlite.html">sqlite</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.html">tools<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html">render<span></span></a>
						<ul>
				<li><a href="package-Mekayotl.tools.render.html.html">html</a>
						</li>
							</ul></li>
				<li><a href="package-Mekayotl.tools.renders.html">renders</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li><a href="package-PHPMailer.html">PHPMailer</a>
						</li>
				<li><a href="package-Services.html">Services<span></span></a>
						<ul>
				<li><a href="package-Services.JSON.html">JSON</a>
						</li>
							</ul></li>
				<li class="active"><a href="package-Swift.html">Swift<span></span></a>
						<ul>
				<li><a href="package-Swift.ByteStream.html">ByteStream</a>
						</li>
				<li><a href="package-Swift.CharacterStream.html">CharacterStream</a>
						</li>
				<li><a href="package-Swift.Encoder.html">Encoder</a>
						</li>
				<li><a href="package-Swift.Events.html">Events</a>
						</li>
				<li class="active"><a href="package-Swift.KeyCache.html">KeyCache</a>
						</li>
				<li><a href="package-Swift.Mailer.html">Mailer</a>
						</li>
				<li><a href="package-Swift.Mime.html">Mime</a>
						</li>
				<li><a href="package-Swift.Plugins.html">Plugins</a>
						</li>
				<li><a href="package-Swift.Transport.html">Transport</a>
						</li>
							</ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-Swift_KeyCache_ArrayKeyCache.html">Swift_KeyCache_ArrayKeyCache</a></li>
				<li><a href="class-Swift_KeyCache_DiskKeyCache.html">Swift_KeyCache_DiskKeyCache</a></li>
				<li><a href="class-Swift_KeyCache_DummyKeyCache.html">Swift_KeyCache_DummyKeyCache</a></li>
				<li><a href="class-Swift_KeyCache_NullKeyCache.html">Swift_KeyCache_NullKeyCache</a></li>
				<li><a href="class-Swift_KeyCache_SimpleKeyCacheInputStream.html">Swift_KeyCache_SimpleKeyCacheInputStream</a></li>
			</ul>

			<h3>Interfaces</h3>
			<ul>
				<li class="active"><a href="class-Swift_KeyCache.html">Swift_KeyCache</a></li>
				<li><a href="class-Swift_KeyCache_KeyCacheInputStream.html">Swift_KeyCache_KeyCacheInputStream</a></li>
			</ul>




		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-Swift.KeyCache.html" title="Summary of Swift\KeyCache"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Interface Swift_KeyCache</h1>


	<div class="description">
	
<p>Provides a mechanism for storing data using two keys.</p>

	</div>





	<div>
		<h4>Direct known implementers</h4>
			<a href="class-Swift_KeyCache_ArrayKeyCache.html">Swift_KeyCache_ArrayKeyCache</a>, 
			<a href="class-Swift_KeyCache_DiskKeyCache.html">Swift_KeyCache_DiskKeyCache</a>, 
			<a href="class-Swift_KeyCache_DummyKeyCache.html">Swift_KeyCache_DummyKeyCache</a>, 
			<a href="class-Swift_KeyCache_NullKeyCache.html">Swift_KeyCache_NullKeyCache</a>
	</div>




	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-Swift.html">Swift</a>\<a href="package-Swift.KeyCache.html">KeyCache</a><br />

				<b>Author:</b>
				Chris Corbyn<br />
		<b>Located at</b> <a href="source-class-Swift_KeyCache.html#11" title="Go to source code">lib/php/externals/swift/classes/Swift/KeyCache.php</a><br />
	</div>


	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="setString" id="_setString">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_setString">#</a>
		<code><a href="source-class-Swift_KeyCache.html#27" title="Go to source code">setString</a>( <span>string <var>$nsKey</var></span>, <span>string <var>$itemKey</var></span>, <span>string <var>$string</var></span>, <span>integer <var>$mode</var></span> )</code>

		<div class="description short">
			
<p>Set a string into the cache under $itemKey for the namespace $nsKey.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Set a string into the cache under $itemKey for the namespace $nsKey.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$nsKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$itemKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$string</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$mode</var></dt>
					<dd><code>integer</code></dd>
				</dl></div>



				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_KeyCache.html#MODE_WRITE">Swift_KeyCache::<b>MODE_WRITE</b></a></code></code>, <code><code><a href="class-Swift_KeyCache.html#MODE_APPEND">Swift_KeyCache::<b>MODE_APPEND</b></a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="importFromByteStream" id="_importFromByteStream">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_importFromByteStream">#</a>
		<code><a href="source-class-Swift_KeyCache.html#38" title="Go to source code">importFromByteStream</a>( <span>string <var>$nsKey</var></span>, <span>string <var>$itemKey</var></span>, <span><code><a href="class-Swift_OutputByteStream.html">Swift_OutputByteStream</a></code> <var>$os</var></span>, <span>integer <var>$mode</var></span> )</code>

		<div class="description short">
			
<p>Set a ByteStream into the cache under $itemKey for the namespace $nsKey.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Set a ByteStream into the cache under $itemKey for the namespace $nsKey.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$nsKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$itemKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$os</var></dt>
					<dd><code><code><a href="class-Swift_OutputByteStream.html">Swift_OutputByteStream</a></code></code></dd>
					<dt><var>$mode</var></dt>
					<dd><code>integer</code></dd>
				</dl></div>



				<h4>See</h4>
				<div class="list">
						<code><code><a href="class-Swift_KeyCache.html#MODE_WRITE">Swift_KeyCache::<b>MODE_WRITE</b></a></code></code>, <code><code><a href="class-Swift_KeyCache.html#MODE_APPEND">Swift_KeyCache::<b>MODE_APPEND</b></a></code></code><br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="getInputByteStream" id="_getInputByteStream">

		<td class="attributes"><code>
			 public 
			<code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code>
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getInputByteStream">#</a>
		<code><a href="source-class-Swift_KeyCache.html#50" title="Go to source code">getInputByteStream</a>( <span>string <var>$nsKey</var></span>, <span>string <var>$itemKey</var></span>, <span><code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code> <var>$is</var> = <span class="php-keyword1">NULL</span></span> )</code>

		<div class="description short">
			
<p>Provides a ByteStream which when written to, writes data to $itemKey. NOTE:
The stream will always write in append mode. If the optional third parameter is
passed all writes will go through $is.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Provides a ByteStream which when written to, writes data to $itemKey. NOTE:
The stream will always write in append mode. If the optional third parameter is
passed all writes will go through $is.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$nsKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$itemKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$is</var></dt>
					<dd><code><code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code></code><br>$is, optional</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code><code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code></code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getString" id="_getString">

		<td class="attributes"><code>
			 public 
			string
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getString">#</a>
		<code><a href="source-class-Swift_KeyCache.html#63" title="Go to source code">getString</a>( <span>string <var>$nsKey</var></span>, <span>string <var>$itemKey</var></span> )</code>

		<div class="description short">
			
<p>Get data back out of the cache as a string.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get data back out of the cache as a string.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$nsKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$itemKey</var></dt>
					<dd><code>string</code></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>string</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="exportToByteStream" id="_exportToByteStream">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_exportToByteStream">#</a>
		<code><a href="source-class-Swift_KeyCache.html#72" title="Go to source code">exportToByteStream</a>( <span>string <var>$nsKey</var></span>, <span>string <var>$itemKey</var></span>, <span><code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code> <var>$is</var></span> )</code>

		<div class="description short">
			
<p>Get data back out of the cache as a ByteStream.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Get data back out of the cache as a ByteStream.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$nsKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$itemKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$is</var></dt>
					<dd><code><code><a href="class-Swift_InputByteStream.html">Swift_InputByteStream</a></code></code><br> to write the data to</dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="hasKey" id="_hasKey">

		<td class="attributes"><code>
			 public 
			boolean
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_hasKey">#</a>
		<code><a href="source-class-Swift_KeyCache.html#82" title="Go to source code">hasKey</a>( <span>string <var>$nsKey</var></span>, <span>string <var>$itemKey</var></span> )</code>

		<div class="description short">
			
<p>Check if the given $itemKey exists in the namespace $nsKey.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Check if the given $itemKey exists in the namespace $nsKey.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$nsKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$itemKey</var></dt>
					<dd><code>string</code></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>boolean</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="clearKey" id="_clearKey">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_clearKey">#</a>
		<code><a href="source-class-Swift_KeyCache.html#91" title="Go to source code">clearKey</a>( <span>string <var>$nsKey</var></span>, <span>string <var>$itemKey</var></span> )</code>

		<div class="description short">
			
<p>Clear data for $itemKey in the namespace $nsKey if it exists.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Clear data for $itemKey in the namespace $nsKey if it exists.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$nsKey</var></dt>
					<dd><code>string</code></dd>
					<dt><var>$itemKey</var></dt>
					<dd><code>string</code></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	<tr data-order="clearAll" id="_clearAll">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_clearAll">#</a>
		<code><a href="source-class-Swift_KeyCache.html#99" title="Go to source code">clearAll</a>( <span>string <var>$nsKey</var></span> )</code>

		<div class="description short">
			
<p>Clear all data in the namespace $nsKey if it exists.</p>

		</div>

		<div class="description detailed hidden">
			
<p>Clear all data in the namespace $nsKey if it exists.</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$nsKey</var></dt>
					<dd><code>string</code></dd>
				</dl></div>





		</div>
		</div></td>
	</tr>
	</table>




	<table class="summary" id="constants">
	<caption>Constants summary</caption>
	<tr data-order="MODE_WRITE" id="MODE_WRITE">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_KeyCache.html#20" title="Go to source code"><b>MODE_WRITE</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">1</span></code></td>
		<td class="description"><div>
			<a href="#MODE_WRITE" class="anchor">#</a>

			<div class="description short">
				
<p>Mode for replacing existing cached data</p>

			</div>

			<div class="description detailed hidden">
				
<p>Mode for replacing existing cached data</p>


			</div>
		</div></td>
	</tr>
	<tr data-order="MODE_APPEND" id="MODE_APPEND">

		<td class="attributes"><code>
			integer
		</code></td>
		<td class="name"><code>
				<a href="source-class-Swift_KeyCache.html#23" title="Go to source code"><b>MODE_APPEND</b></a>
		</code></td>
		<td class="value"><code><span class="php-num">2</span></code></td>
		<td class="description"><div>
			<a href="#MODE_APPEND" class="anchor">#</a>

			<div class="description short">
				
<p>Mode for appending data to the end of existing cached data</p>

			</div>

			<div class="description detailed hidden">
				
<p>Mode for appending data to the end of existing cached data</p>


			</div>
		</div></td>
	</tr>
	</table>






</div>

	<div id="footer">
		nort API documentation generated by <a href="http://apigen.org">ApiGen 2.7.0</a>
	</div>
</div>
</div>
</body>
</html>
